package jpavlich.cardsorter.sound;
/*
 * Copyright (c) 1999 - 2003 by Matthias Pfisterer
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
import javax.sound.sampled.AudioFormat;

class SupportedFormat {
	/**
	 * The name of the format.
	 */
	private String m_strName;

	/**
	 * The encoding of the format.
	 */
	private AudioFormat.Encoding m_encoding;

	/**
	 * The sample size of the format. This value is in bits for a single
	 * sample (not for a frame).
	 */
	private int m_nSampleSize;

	/**
	 * The endianess of the format.
	 */
	private boolean m_bBigEndian;

	// sample size is in bits
	/**
	 * Construct a new supported format.
	 * 
	 * @param strName
	 *            the name of the format.
	 * @param encoding
	 *            the encoding of the format.
	 * @param nSampleSize
	 *            the sample size of the format, in bits.
	 * @param bBigEndian
	 *            the endianess of the format.
	 */
	public SupportedFormat(String strName, AudioFormat.Encoding encoding, int nSampleSize,
			boolean bBigEndian) {
		m_strName = strName;
		m_encoding = encoding;
		m_nSampleSize = nSampleSize;
	}

	/**
	 * Returns the name of the format.
	 */
	public String getName() {
		return m_strName;
	}

	/**
	 * Returns the encoding of the format.
	 */
	public AudioFormat.Encoding getEncoding() {
		return m_encoding;
	}

	/**
	 * Returns the sample size of the format. This value is in bits.
	 */
	public int getSampleSize() {
		return m_nSampleSize;
	}

	/**
	 * Returns the endianess of the format.
	 */
	public boolean getBigEndian() {
		return m_bBigEndian;
	}
}